From 2b31f26827550e99836e54455538a5ca10b01cba Mon Sep 17 00:00:00 2001 From: Sven Herzberg Date: Thu, 11 Dec 2008 13:09:27 +0000 Subject: [PATCH] Document the "set-scroll-adjustments" signal 2008-12-11 Sven Herzberg Document the "set-scroll-adjustments" signal Reviewed by Kristian Rietveld. * gtk/gtkiconview.c, * gtk/gtklayout.c, * gtk/gtktextview.c, * gtk/gtktreeview.c, * gtk/gtkviewport.c: added proper documentation for the signal svn path=/trunk/; revision=21871 --- ChangeLog | 12 ++++++++++++ gtk/gtkiconview.c | 9 +++++++++ gtk/gtklayout.c | 9 +++++++++ gtk/gtktextview.c | 9 +++++++++ gtk/gtktreeview.c | 9 +++++++++ gtk/gtkviewport.c | 9 +++++++++ 6 files changed, 57 insertions(+) diff --git a/ChangeLog b/ChangeLog index 37a0233a9b..ee268696a8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2008-12-11 Sven Herzberg + + Document the "set-scroll-adjustments" signal + + Reviewed by Kristian Rietveld. + + * gtk/gtkiconview.c, + * gtk/gtklayout.c, + * gtk/gtktextview.c, + * gtk/gtktreeview.c, + * gtk/gtkviewport.c: added proper documentation for the signal + 2008-12-11 Daniel Elstner Bug 563994 – Input method module interface not documented diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c index b5157c4e48..05ad6b5a6a 100644 --- a/gtk/gtkiconview.c +++ b/gtk/gtkiconview.c @@ -777,6 +777,15 @@ gtk_icon_view_class_init (GtkIconViewClass *klass) GTK_PARAM_READABLE)); /* Signals */ + /** + * GtkIconView::set-scroll-adjustments + * @horizontal: the horizontal #GtkAdjustment + * @vertical: the vertical #GtkAdjustment + * + * Set the scroll adjustments for the icon view. Usually scrolled containers + * like #GtkScrolledWindow will emit this signal to connect two instances + * of #GtkScrollbar to the scroll directions of the #GtkIconView. + */ widget_class->set_scroll_adjustments_signal = g_signal_new (I_("set-scroll-adjustments"), G_TYPE_FROM_CLASS (gobject_class), diff --git a/gtk/gtklayout.c b/gtk/gtklayout.c index ccd8ede6bf..153a2dfca4 100644 --- a/gtk/gtklayout.c +++ b/gtk/gtklayout.c @@ -658,6 +658,15 @@ gtk_layout_class_init (GtkLayoutClass *class) class->set_scroll_adjustments = gtk_layout_set_adjustments; + /** + * GtkLayout::set-scroll-adjustments + * @horizontal: the horizontal #GtkAdjustment + * @vertical: the vertical #GtkAdjustment + * + * Set the scroll adjustments for the layout. Usually scrolled containers + * like #GtkScrolledWindow will emit this signal to connect two instances + * of #GtkScrollbar to the scroll directions of the #GtkLayout. + */ widget_class->set_scroll_adjustments_signal = g_signal_new (I_("set-scroll-adjustments"), G_OBJECT_CLASS_TYPE (gobject_class), diff --git a/gtk/gtktextview.c b/gtk/gtktextview.c index 9af93c89de..a45b390f5a 100644 --- a/gtk/gtktextview.c +++ b/gtk/gtktextview.c @@ -913,6 +913,15 @@ gtk_text_view_class_init (GtkTextViewClass *klass) _gtk_marshal_VOID__VOID, G_TYPE_NONE, 0); + /** + * GtkTextView::set-scroll-adjustments + * @horizontal: the horizontal #GtkAdjustment + * @vertical: the vertical #GtkAdjustment + * + * Set the scroll adjustments for the text view. Usually scrolled containers + * like #GtkScrolledWindow will emit this signal to connect two instances + * of #GtkScrollbar to the scroll directions of the #GtkTextView. + */ signals[SET_SCROLL_ADJUSTMENTS] = g_signal_new (I_("set-scroll-adjustments"), G_OBJECT_CLASS_TYPE (gobject_class), diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c index bff4ae851b..703f07935d 100644 --- a/gtk/gtktreeview.c +++ b/gtk/gtktreeview.c @@ -869,6 +869,15 @@ gtk_tree_view_class_init (GtkTreeViewClass *class) GTK_PARAM_READABLE)); /* Signals */ + /** + * GtkTreeView::set-scroll-adjustments + * @horizontal: the horizontal #GtkAdjustment + * @vertical: the vertical #GtkAdjustment + * + * Set the scroll adjustments for the tree view. Usually scrolled containers + * like #GtkScrolledWindow will emit this signal to connect two instances + * of #GtkScrollbar to the scroll directions of the #GtkTreeView. + */ widget_class->set_scroll_adjustments_signal = g_signal_new (I_("set-scroll-adjustments"), G_TYPE_FROM_CLASS (o_class), diff --git a/gtk/gtkviewport.c b/gtk/gtkviewport.c index ad5a310441..3e64564611 100644 --- a/gtk/gtkviewport.c +++ b/gtk/gtkviewport.c @@ -125,6 +125,15 @@ gtk_viewport_class_init (GtkViewportClass *class) GTK_SHADOW_IN, GTK_PARAM_READWRITE)); + /** + * GtkViewport::set-scroll-adjustments + * @horizontal: the horizontal #GtkAdjustment + * @vertical: the vertical #GtkAdjustment + * + * Set the scroll adjustments for the viewport. Usually scrolled containers + * like #GtkScrolledWindow will emit this signal to connect two instances + * of #GtkScrollbar to the scroll directions of the #GtkViewport. + */ widget_class->set_scroll_adjustments_signal = g_signal_new (I_("set-scroll-adjustments"), G_OBJECT_CLASS_TYPE (gobject_class), -- 2.30.2